Contents

Installation

Configuration

Help Compiler

Help Project Editor

Hot Spot Editor

New Features

Icon Bar

Building Your First Help File

Notes

Registration


Installation

If you haven't already installed HelpMaker 3.0, you'll find it's quite simple.  There is no automated setup program, but all that's necessary is copying a few files to different locations.

Veteran HelpMaker users are aware that previous versions of HelpMaker shipped with it's own style sheet.  That is not the case any longer.  When HelpMaker is first started, it looks for a style sheet called HM.STY in your default style sheet directory.  If it is not there, then HelpMaker will build it for you automatically in a few seconds.  This presents two benefits.  One less file to package with HelpMaker (less trouble for me, less download time for you) and assurance that you can always get a fresh copy if your old style sheet becomes damaged or accidentally changed.

After HelpMaker creates the style sheet you can format it as you please (face, size, color, alignment, etc.), however, it is suggested that you not alter any of the Breaks or Bullets & Numbers parts of the paragraph styles.  The styles are setup to be recognized in a specific way by the Windows Help Compiler.

What goes where:

HM-8514.DLL

HM-VGA.DLL

HM-EGA.DLL

HM-PAL.SMI and

HM.HLP all go in a directory of your choosing.  Suggestion: I use C:\HM

HM.SAM should be placed in your default Ami Pro document directory.

HCP.PIF

HM.RTF and

HM.HPJ should be placed in the same directory where your Help Compiler, Help Project Editor, and Hot Spot Editor are kept.

HM.SMM should be placed in your default Ami Pro macros directory.  This can be determined by starting Ami Pro, then selecting Tools/User Setup/Paths.

Once you have all the files in place:

1. Start Ami Pro.

2. Select Tools/Macros/Playback.

3. Scroll down the list titled Macros until you see HM.SMM.

4. Select HM.SMM and click on OK.

This should add a HelpMaker 3.0 menu at the beginning of your menu bar and display an icon bar at the lower right-hand corner of your screen.  You will initially see the Configuration panel of this help file.  Also, the About HelpMaker dialog will appear.  For unregistered users, this dialog box will continue to appear.  Registration will make this go away.

See also:

Configuration

Notes


Configuration

If this is your first time to use HelpMaker 3.0, there are a few steps that will make things flow more smoothly for you.

First, select the HelpMaker 3.0 menu and then select Setup.  You will see the following items listed there:

RTF Path

Project Editor

Hot Spot Editor

Help Compiler and

Disable Resume Boxes

Each of these is explained below:

RTF Path

Select HelpMaker 3.0/Setup/RTF Path...

When RTF Path is selected, you are presented with a dialog box prompting you to change to the directory on your hard drive where you will be storing the Rich Text Format files saved from HelpMaker.  Suggestion: make this the same directory in which you store your Windows Help Compiler.

Project Editor

Select HelpMaker 3.0/Setup/Project Editor...

When Project Editor is selected, you are presented with a dialog box prompting you to change to the directory on your hard drive where your Help Project Editor is stored.  Suggestion: make this the same directory in which you store your Windows Help Compiler.

Hot Spot Editor

Select HelpMaker 3.0/Setup/Hot Spot Editor...

When Hot Spot Editor is selected, you are presented with a dialog box prompting you to change to the directory on your hard drive where your Hot Spot Editor is stored.  Suggestion: make this the same directory in which you store your Windows Help Compiler.

Help Compiler

Select HelpMaker 3.0/Setup/Help Compiler...

When Help Compiler is selected, you are presented with a dialog box prompting you to change to the directory on your hard drive where your Windows Help Compiler is stored.  Suggestion: make this the same directory in which you store your Windows Help Compiler.

Disable Resume Boxes

Select HelpMaker 3.0/Setup/Disable Resume Boxes (For Advanced Users Only)

This is a feature for experienced users of HelpMaker.  During the process of building your help file (as explained in Building Your First Help File) you are prompted by different Macro Pause dialogs which ask you to perform a specific action, then click on Resume.  The Disable Resume Boxes feature allows you to turn off this behavior thus making help file creation faster.  Suggestion: it is recommended to leave resume boxes enabled until you are quite experienced with HelpMaker.

See also:

Installation

Notes


Help Compiler

HelpMaker 3.0 was designed using the Microsoft Help Compiler version 3.10.505.  It may very well, more likely than not, work with earlier or later versions of the same product, or with WinHelp compilers distributed by other manufacturers.  However, I can only guaranty that the formatting done to your Ami Pro 3.0  document will be interpreted properly when used with the version mentioned above.

See also:

Notes


Help Project Editor

This would be an application you have which is capable of automating the process of creating a help project file (.HPJ).  More information can be found on help project files in the Windows Help Authoring Guide.  Suggestion: As of the time of creating this help file, according to a Microsoft technote, an application called Help Project Editor can be downloaded from the Microsoft Software Library on CompuServe.  GO MSL and download WHAT6.EXE.  This is the project editor I use and has been very handy.  However, it is not necessary in order to create a WinHelp file.  Note: the version of the Microsoft Help Project Editor I use is 1.00.0014.


Hot Spot Editor

This would be an application you have which is capable of editing SHG, BMP, WMF or DIB graphic files.  The Hot Spot Editor allows you to define "hot spots" on a graphic which can be linked to help file topics or popup boxes (most common application).  As of the time of this help file creation, the Microsoft Hot Spot Editor can be downloaded from the WINSDK forum on CompuServe.  The file name is SHED.ZIP.  Note: the version I use is 3.50.784.


New Features

HelpMaker 3.0 is an attempt to spit-shine many of the original features, as well as add a few more.  Improvements and additions in this version are listed below:

HelpMaker 3.0/File/New - creates a new document using HM.STY.  If HM.STY does not exist, it creates it for you and automatically sets the first paragraph style to Heading.

HelpMaker 3.0/File/Open - allows you to open a saved RTF file, or it's relative Ami Pro .SAM file.  When a file is saved using HelpMaker 3.0, it saves the file as a RTF (Rich Text Format) file, but also saves a duplicate in your default Ami Pro document directory with the same name, but using the .SAM extension (Ami Pro document format).  I know, I know.  You're wondering why I would do such a strange thing.  Well, when an RTF file is saved, then reopened, something is lost in reference to the help file creation formatting done to it.  The help compiler seems to gripe about things even though it looks fine on screen.  Well, an option called Open relative SAM has been provided (and is default) in the File/Open dialog.  You do have the option to open the RTF, however.

HelpMaker 3.0/File/Save - as mentioned above, the current file is saved as RTF and as an Ami Pro document.

HelpMaker 3.0/Create Object.../Popup Box - In the past, HelpMaker users could designate text as a popup mark and then they were told "remember to do this....."  No longer.  Now, HelpMaker formats the popup mark and automatically creates the popup box text at the end of your help file.

HelpMaker 3.0/Create Object.../Register Routine - This is a function that will be used by advanced WinHelp authors.  It automates the process of creating RegisterRoutine entries in the [CONFIG] section of the help project file.  It also allows to create a hot spot or footnote RegisterRoutine call.

HelpMaker 3.0/Project Editor.../Open .HPJ File... - allows user to specify a .HPJ project file to be opened when your Help Project Editor is started.

HelpMaker 3.0/Hot Spot Editor.../Start... - executes your Hot Spot Editor.

HelpMaker 3.0/Hot Spot Editor.../Open BMP/SHG/WMP/DIB File... - allows user to specify a graphic file to be opened when your Hot Spot Editor is started.

HelpMaker 3.0/Setup/Default Font and Size... - allows you to specify what font face and size is used during automatic style sheet creation (in the event HM.STY does not exist).

HelpMaker 3.0/Setup/Disable Resume Boxes (For Advanced Users Only) - allows you to turn off Macro Pause dialogs during document formatting.  Read the help panel in this file titled Configuration.

HelpMaker 3.0/Page Background - allows you to specify a color for the page background in the event you specify a similar color in your help project file for the background of the help window.  This makes formatting a bit more WYSIWYG in that you'll probably be changing the color of your text in such a case.

HelpMaker 3.0/Show/Hide Icon Bar - self explanatory.  More information is available under the help topic Icon Bar.

Icon Bar - Text descriptions added to icons.  Remembers it's last position.


Icon Bar

The icon bar is self-explanatory.  Each button has text on it to indicate its purpose.  My suggestion is to play around with all of them in a dummy file that you don't intend on keeping.  This should familiarize you on how each behaves.

The icon remembers its last position, but in order for it to remember, you have to exit HelpMaker either by selecting HelpMaker 3.0/Exit or by clicking on the Exit button on the icon bar itself.  One of those two processes will "remember" the last icon bar position for you.  The position will not be remembered if Ami Pro is exited while HelpMaker is running.


Building Your First Help File

If you've never authored a WinHelp file before, the following instructions will step you through your first.  Otherwise, they'll simply familiarize you with some of the functions of HelpMaker.  These instructions assume that you have obtained a help compiler and help project editor.  They also assume that you have configured HelpMaker as described under the help topic Configuration.

1. On the icon bar, click on the New button.  A blank document appears.  When the cursor is on the first line of the page, it should say Heading at the lower left-hand corner of the screen.  This indicates that the Heading paragraph style is currently being used.

2. Type the word "Contents" (without the quotes).  Press ENTER twice.

3. Type a bit of garbage, then press ENTER twice again.

4. Type the words "Second Panel".  Press ENTER twice.

5. Click on the Page Break button on the icon bar.  You should have a new page now.

6. Type the words "Second Panel".  Press ENTER twice.

7. Type a bit of garbage, then press ENTER twice again.

8. Type the word "Contents" and press ENTER.

9. Go back to page 1, place the insertion point on the line with the word "Contents" at the top.

10. Click on the Topic button on the icon bar.  You are prompted to place the cursor on the topic line (which you have already done) and then click Resume.  Go ahead and click Resume now.  HelpMaker proceeds to create several footnote references.  It then stops and asks you to enter a number.

11. Type "0000" in the dialog box and click on OK.

12. Just below that topic, you had typed the words "Second Panel".  Highlight those words, FROM LEFT TO RIGHT, then click on the Jump Mark button on the icon bar.  HelpMaker prompts you to select the text (which you've already done) and then click Resume.

13. Click on Resume.  HelpMaker proceeds to format the text appropriately and create another entry just beside it.

14. Go back to page 2 and place your insertion point on the first line with the words "Second Panel".  Click the topic button on the icon bar as you did in step 10.  But, this time, type in the number "0010" when prompted.  Click on OK.

15. Just below that topic, highlight the word "Contents", FROM LEFT TO RIGHT, then click on the Jump Mark button on the icon bar.  Click on Resume.

16. Click on the Save button on the icon bar.  It should default to RTF directory (explained under the help topic Configuration) and UNTITLED.RTF as the file name.  These are acceptable.  Click on OK.

OK, breathe.  You have just completed the formatting of your first WinHelp file.  All we have to do now is create a project file, then compile it.  Did you remember to start your stopwatch?

17. Click on the .HPJ button on the icon bar.  Your Help Project Editor should start.  The following instructions assume that you are using the Microsoft Help Project Editor version 1.00.0014.  If not, go directly to step .

18. Select Edit/Add New or Existing File.  Select the RTF file that you saved in step 16.  Click on OK.

19. Select Edit/Project.

20. In the Title box, type the text you want to appear in the titlebar of the help window.

21. In the Contents box, type the word "Contents" (without the quotes).

22. Select Help Version 3.1.  Click on OK.

23. Select Edit/Compression.  Select High.  Turn OFF Use Old Keyphrase.

24. Select Edit/Window Definitions.

25. Under Background Colors, click on the list labeled Scrolling Region.  Select Yellow.

26. Click on the list labeled Non-scrolling Region.  Select Grey (their spelling, not mine).  Click on OK.

27. Select File/Save As.  It's a good practice to name your .HPJ file with the same name as the RTF except you'll use an .HPJ extension.  Click on OK.

28. Close the Help Project Editor.

29. On the HelpMaker icon bar, click on the Compile button.

30. Select the .HPJ file you just finished saving in step 27.

31. Click on OK.  The Help Compiler should start.  Let it be.  WHEN IT FINISHES, click on the Resume button.  This should automatically open the WinHelp file you just created.  Play with it a bit.  Click on the jump marks.

Congratulations.  You've just completed what might be your first WinHelp file.

See also:

Icon Bar


Notes

The pif file, HCP.PIF, that comes with HelpMaker 3.0 is set to run a help compiler with the filename HCP.EXE.  It is also set to run it from a directory called C:\HELPCOMP.  If this is not your situation, you can edit the .pif file by using PIFEDIT.EXE that comes with Microsoft Windows.

If you start HelpMaker 3.0 and your icon bar appears but with no icons, check the following:

1. Make sure you have your HelpMaker program files setup as per the directions under Installation.

2. Make sure there is a file in your Ami Pro program directory called OUTDLL.DLL.  If you are using Ami Pro in a shared network environment, you may not have sufficient rights to the Ami Pro program directory and may need the assistance of a network administrator to put OUTDLL.DLL in the program directory for you.

3. Select HelpMaker 3.0/Help/About for information on how to contact me.

The following files used to create this help file are included with HelpMaker 3.0 to be an example for you:

HM.SAM

HM.HPJ

HelpMaker 3.0 is designed and guaranteed by me ONLY to work with Ami Pro 3.0 for Windows.  You may get satisfactory results from HelpMaker 3.0 in other versions of Ami Pro, however, I will be unable to support it in such a situation.

The author will not be held responsible for any losses, whether real or intangible, due to the usage of HelpMaker 3.0.


Registration

HelpMaker 3.0 is not freeware.  You are allowed 30 days to use the program free of charge in order to evaluate it and equate its usefulness, or the lack thereof, to you.  After which time, you are required to register each installation of HelpMaker 3.0.  Registration makes the About box disappear and includes the new AutoRegisterRoutine feature.

To register HelpMaker 3.0, send $25.00 American dollars in check or money order to:

Cris Williams

3112 Moriah Trails, #207

Memphis, TN  38115

Bulk rates available.

I can also be contacted via the following:

CompuServe: 71700,3523

Internet: 71700.3523@compuserve.com

Phone: 901-362-1844

Suggestions and complaints are welcome.

Bug reports will be rewarded - free upgrade to the next version of HelpMaker (one per customer).  Stipulations:

1. If you find a problem with HelpMaker 3.0, report it to me, and

2. If this problem is fixed in a later release of HelpMaker 3.0, should there be a later release, and

3. Your report is one of the first ten of reports concerning that specific problem.

Microsoft, Windows, Help Compiler, Help Project Editor, and Hot Spot Editor are all registered trademarks of Microsoft Corporation.


Run

Allows you to execute WINHELP.EXE and open the selected WinHelp file.


Macro

Depending on whether you selected Macro Hotspot or Macro Footnote, this function will allow you to insert a WinHelp macro.  See Help Compiler documentation on parameters and usage of these macros.


RegisterRoutine

This is an advanced WinHelp macro that allows an author to embed function calls to DLL program files into the WinHelp file.  The Register Routine function of HelpMaker automates this process.  Programming experience is usually necessary to use this macro.


Compile and Test

This function allows you to select preferably an .HPJ, or RTF, file to compile your Rich Text File into a WinHelp file.  The help compiler normally runs in a DOS window.  After the compilation has ended, you can click on a Resume button to view the newly created WinHelp file.